home *** CD-ROM | disk | FTP | other *** search
/ Aminet 1 (Walnut Creek) / Aminet - June 1993 [Walnut Creek].iso / aminet / gfx / pbm / texts.lzh / amiga.readme next >
Text File  |  1992-04-24  |  12KB  |  307 lines
  1.                         PBMPlus version 10dec91
  2.                             Amiga release
  3.  
  4.  
  5. LEGAL STUFF
  6. -----------
  7. The original README-file (see texts.lzh) and the manuals are rather free on
  8. what is allowed with the PBMPlus sources.  However, this does NOT apply to
  9. this Amiga version of PBMPlus.  Well, I would like to simply say "do with it
  10. what you want", but there is a great danger that some `PD Distributor' then
  11. sells this package for a lot of $$$.  If you don't like these restrictions,
  12. you are free to make your own port of PBMPlus, the sources are available on
  13. a lot of FTP sites.
  14.  
  15. The Amiga version of PBMPlus may be distributed freely, with the following
  16. conditions:
  17.  
  18.     * The ENTIRE package must be distributed UNCHANGED.  Compression with
  19.       common archivers like zoo or lharc is allowed.  Remember, this
  20.       condition does apply to ALL forms of distribution, be it via floppy
  21.       disks, BBS'es, electronic networks (FTP sites), or other means.
  22.  
  23.     * Distribution may only be on a NON-PROFIT basis.  The distributor
  24.       may only charge for media and postage costs, and a MINIMAL copying
  25.       fee.  For disk-based distributions, the total fee/disk (including
  26.       media cost, but not including postage) may never exceed DM 5.00 in
  27.       Germany or US$ 5.00 (or an equivalent amount in your local currency)
  28.       outside Germany.  For other MAGNETIC media (like streamer tapes or
  29.       SyQuest's) the copying fee (not including media costs or postage)
  30.       may never exceed DM 2.50 or US$ 2.50, respectively.  Distribution on
  31.       NON-MAGNETIC media (like CD's) is not allowed without my written
  32.       permission.
  33.  
  34.     * Distribution via electronic networks or BBS systems is allowed if
  35.       those systems make no copyright or ownership claims to uploaded
  36.       software and do not charge for downloading other than standard
  37.       online costs.
  38.  
  39.     * Inclusion in any commercial software package is not allowed without
  40.       my written permission.
  41.  
  42.     * Likewise, distribution on any magazine disk is not allowed without
  43.       my written permission.
  44.  
  45. As always, Fred Fish has explicit permission to include this package in his
  46. wonderful "Fish Disks".
  47.  
  48. You don't have to pay me anything to use this software, but if you think I've
  49. done a good job in porting this stuff and want to give me some reward, send
  50. me a nice picture-postcard of your home town/country.  See the BUG REPORTS
  51. section for my address.
  52.  
  53. Standard Disclaimer: This software is provided "as is", without any warranty,
  54. either expressed or implied...blablabla.  In short: You get this stuff for
  55. free, so if it nukes your computer, melts your harddisk or kills your cat
  56. that's your problem, not mine.
  57.  
  58.  
  59.  
  60. WHAT IS PBMPLUS?
  61. ----------------
  62. PBMPlus is a toolkit to convert and manipulate graphic images.  It was
  63. written and is maintained by Jef Poskanzer (jef@well.sf.ca.us), and lots of
  64. people have provided additional programs, bugfixes and enhancements.  Read
  65. the manuals for information on who wrote which program.
  66.  
  67. PBMPlus is a set of shell programs that act as filters, meaning they read 
  68. from a file or stdin and write to stdout.  There is NO graphical interface
  69. (yet).  PBMPlus doesn't convert directly from and to standard graphic formats
  70. like GIF or IFF-ILBM, it uses three intermediate formats:
  71.  
  72.     PBM = `portable bitmap' (1bit black&white)
  73.     PGM = `portable gray map' (8bit greyscales)
  74.     PPM = `portable pix map' (24bit color)
  75.  
  76. The formats are upward compatible, PGM programs can read both PBM and PGM and
  77. write PGM, PPM programs can read all three and write PPM.  There are also PNM
  78. programs (PNM = `portable anymap'), these work on all three formats and write
  79. the same format as they read.  (There is no PNM format!)
  80.  
  81. The great advantage is that for a conversion between N formats only 2*N
  82. converters are needed, instead of (N-1)*N.  For example, to convert between
  83. GIF, TGA, PCX and IFF-ILBM you only need 8 programs:
  84.  
  85.     giftoppm, ppmtogif, tgatoppm, ppmtotga, pcxtoppm, ppmtopcx, ilbmtoppm
  86.     and ppmtoilbm
  87.  
  88. instead of 12:
  89.  
  90.     giftotga, giftopcx, giftoilbm, tgatogif, tgatopcx, tgatoilbm, pcxtogif,
  91.     pcxtotga, pcxtoilbm, ilbmtogif, ilbmtotga and ilbmtopcx
  92.  
  93. Another advantage is that if yet another graphic format appears, all that is
  94. needed are the newtop?m and p?mtonew filters, and you are able to convert the
  95. new format to and from any other (old) format.
  96.  
  97. The disadvantage is that two commands are needed to convert an image, i.e.:
  98.  
  99.     giftoppm  >mypic.ppm mypic.gif
  100.     ppmtoilbm >mypic.iff mypic.ppm
  101.  
  102. or on Unix-like shells:   giftoppm mypic.gif | ppmtoilbm > mypic.iff
  103.  
  104. Another disadvantage is that the intermediate files get quite big, for example
  105. a 1024x768 PPM picture needs 1024*768*3 bytes = 2.25MB.
  106.  
  107.  
  108. PBMPlus also includes a lot of tools that manipulate the intermediate formats
  109. in some way.  For example, to convert a GIF of any size to a 320*200 IFF-ILBM
  110. you could do this:
  111.  
  112.     giftoppm  >mypic.ppm mypic.gif
  113.     pnmscale  >mypic.ppm2 -xysize 320 200 mypic.ppm
  114.     ppmtoilbm >mypic.iff mypic.ppm2
  115.  
  116. or  giftoppm mypic.gif | pnmscale -xysize 320 200 | ppmtoilbm >mypic.iff
  117.  
  118. You want to turn ASCII text into an IFF-ILBM picture?  No problem:
  119.  
  120.     pbmtext < text.txt > text.pbm
  121.     ppmtoilbm text.pbm > text.iff
  122.  
  123. or  pbmtext < text.txt | ppmtoilbm > text.iff
  124.  
  125.  
  126. For more information on what formats PBMPlus can read and write and what
  127. manipulations are possible, read `FORMATS' and `programs' in texts.lzh.
  128.  
  129.  
  130.  
  131. REQUIREMENTS & INSTALLATION
  132. ---------------------------
  133. These programs run on any Amiga with Kickstart 1.3 or higher.  However, they
  134. are useless on a stock A500.  (Hmm.  Better say an A500 is useless for this
  135. programs. ;-))  You should have a harddisk, lots of memory and a fast CPU.
  136. 3MB of RAM should be sufficient for almost all pictures (up to 1024x768).
  137. Of course, you need some place to write the intermediate files to (a HD).
  138.  
  139. To save space, PBMPlus is distributed in lharc-archives.  Since the whole
  140. package uses over 3MB of disk space and nobody needs all the programs, you
  141. should first decide what you need.  Unpack the texts-archive and read the
  142. `programs' file and the `README' file in the extra-archive.  Most likely, you
  143. want ppmtoilbm, somethingtoppm (in ppmbin?.lzh) and the manipulation tools
  144. (in pnmbin.lzh).  Extract them from the archives with lharc or a compatible
  145. tool (lz or lha) with a command like this:
  146.  
  147.     lharc -m -a -x <archive.lzh> <the-program-you-want>
  148.  
  149. Make sure your extraction program preserves the p-flag (`pure').  For most
  150. lharc-clones, the -a option does this.
  151.  
  152. The mathtrans and mathieeedoub*-libraries must be in LIBS:.  Future versions
  153. will also require the new 2.0 mathieeesing*-libraries.  (Yet another reason
  154. to upgrade to 2.0 ;-))  The libraries are opened with DICE's auto-open
  155. routines, so if they are missing, the programs simply abort WITHOUT printing
  156. an error message.  I don't consider this a flaw, because PBMPlus is rather
  157. useless without a harddisk, and HD-users usually have all important libraries
  158. in LIBS: anyway.
  159.  
  160.  
  161.  
  162. CHANGES FROM THE LAST RELEASE (05oct91)
  163. ---------------------------------------
  164. * obviously, the 30oct91 and 10dec91 patches are applied :-)
  165. * now supports X11 color names file (see SPECIAL FEATURES)
  166. * pnmtotiff and tifftopnm are now included
  167. * compiled with dynamic stacks and register-args
  168. * array allocation routine pm_allocarray() no longer requires continuous RAM
  169.  
  170.  
  171.  
  172. SPECIAL FEATURES
  173. ----------------
  174. WARNING: These features exist ONLY in the Amiga version of PBMPlus.  They may
  175. change or not exist in future versions.
  176.  
  177. ppmtoilbm has a new option: -hamforce.  This causes ppmtoilbm to ALWAYS write
  178. a HAM file, even if the PPM-file only has 2 colors.
  179.  
  180. The path to the X11 color names file is not compiled into the programs, but
  181. taken from the environment variable `RBGDEF'.  If you want to use a names
  182. file (used by pgmtoppm, ppmmake, ppmtouil, ppmtoxpm and xpmtoppm), set the
  183. variable to the full path and name of the names file, i.e.
  184.     setenv RGBDEF  "s:x11/rgb.txt"
  185. An example color names file is included in the extra-archive under
  186.     extra/other/newcolors.rgb
  187.  
  188. All programs, except giftoppm, spctoppm, sputoppm, tgatoppm, pnmtotiff and
  189. tifftopnm are `pure' and can be made resident.  Don't worry about stacksize,
  190. I took all large arrays off the stack into global variables and compiled with
  191. DICE's dynamic stacks.
  192.  
  193.  
  194.  
  195. MISC NOTES
  196. ----------
  197. All programs have two hidden options:
  198.     -quiet      prevents all output from the program.
  199.     -version    displays version information, for bug reports.
  200.  
  201. The option `-?' causes most programs to print a short usage message.
  202.  
  203. For expert users:  The programs have been compiled with PBMPLUS_RAWBITS set,
  204. so they are able to read both raw and ASCII files, but write only raw files.
  205. If you want ASCII files, pipe the output through pnmnoraw.
  206.  
  207.  
  208.  
  209. KNOWN BUGS & MISSING THINGS
  210. ---------------------------
  211. ppmpat is not included in the Amiga release.
  212.  
  213. I didn't bother to convert the scripts to AmigaDOS-scripts (it's nearly
  214. impossible anyway).  If you want to run them, find a Bourne-shell or Csh
  215. clone.
  216.  
  217. ppmquant uses huge amounts of RAM in lots of small pieces (depends on the
  218. number of colors, more than 6MB for 256 colors).  This isn't a problem if
  219. you have enough memory, but otherwise ppmquant will slowly eat away every
  220. available byte, and then the OS will run into deep deep trouble and most
  221. likely produce some nice fireworks.
  222.  
  223. Most of the programs are untested.  However, since they are known to run
  224. under Unix and the DICE compiler produces good code, I expect no problems.
  225.  
  226.  
  227.  
  228. BUG REPORTS & SUPPORT
  229. ---------------------
  230. Please send bug reports to the address below.  Sorry, I cannot answer to bug
  231. reports and other requests other than via e-mail (or for normal mail, you
  232. have to include a self-addressed & stamped envelope).  Hey, this is freeware,
  233. did you expect a phone-hotline?
  234.  
  235. Please describe exactly what you were doing, what went wrong (Guru number?),
  236. what OS version and shell you are using, and your machine type and memory
  237. configuration, the output from running any program with the -version flag,
  238. and if possible include the picture (uuencoded) that caused the problem.
  239. Also, make sure that it's really the PBMPlus-program thats causing the
  240. problems, not some background-utility playing corewar.
  241.  
  242. My address:
  243.     Ingo Wilken
  244.     Bloherfelder Str. 72
  245.     2900 Oldenburg
  246.     W-Germany
  247.  
  248.     E-Mail: Internet: Ingo.Wilken@arbi.informatik.uni-oldenburg.de
  249.             UUCP    : wilken@uniol.UUCP  (...!uunet!unido!uniol!wilken)
  250.             Zerberus: wilken@uniol.ZER
  251.     IRC-Nick: Nobody (usually on `#amiga')
  252.  
  253.  
  254.  
  255. HOW TO GET THE SOURCE AND UPDATES
  256. ---------------------------------
  257. The original source is available via anonymous ftp from:
  258.     ftp.ee.lbl.gov      : pbmplus*.tar.Z
  259.     wuarchive.wustl.edu : graphics/graphics/packages/pbmplus/pbmplus*.tar.Z
  260.     export.lcs.mit.edu  : contrib/pbmplus*.tar.Z
  261.  
  262. The newest Amiga version is always available via anonymous ftp from:
  263.     ftp.informatik.uni-oldenburg.de [134.106.1.9]:  /pub/amiga/pbmplus
  264.  
  265.  
  266. I usually post an announcement to alt.graphics.pixutils and/or
  267. comp.sys.amiga.graphics when a new version or an update is available.
  268.  
  269.  
  270.  
  271. THE FUTURE
  272. ----------
  273. Some thoughts & rumors.  Ideas and comments are welcome, but don't even think
  274. of asking "When will it be available?"...
  275.  
  276. * move standard functions into a shared library (pbmplus.library). This
  277.   library WILL require Kick 2.0!  Use mathieeesing*-libraries for floating
  278.   point math instead of mathffp, it's faster on FPUs.
  279.  
  280. * global -noraw or -plain option? (only if PBMPLUS_RAWBITS defined)
  281.  
  282. * make ALL programs respond with a usage message to a -? option
  283.  
  284. * jpeg <-> ppm filters
  285.  
  286. * Intuition Frontend: Markus Illenseer (markus@techfak.uni-bielefeld.de,
  287.   `ill' on IRC) wants to write one.  Ideas are welcome.  (Kick 2.0 only!)
  288.  
  289.  
  290.  
  291. THANKS TO
  292. ---------
  293. Jef Poskanzer and all other contributors to PBMPlus, of course!
  294. Matt Dillon for his fantastic DICE-compiler.
  295. Markus Illenseer & Stefan Becker (my guinea pigs's, oops, beta-testers :-))
  296.  
  297.  
  298.  
  299. That's it.  Have fun.
  300.  
  301. Ingo
  302. --
  303. Ingo Wilken, CS Student, Univ.of Oldenburg, FRG | You mean I really did all of
  304. wilken@uniol.uucp (..!uunet!unido!uniol!wilken) | dat stuff? Now dat explains
  305. Ingo.Wilken@arbi.informatik.uni-oldenburg.de    | why my head hurts an' why I
  306. wilken@uniol.zer   IRC:Nobody   OL:ingo@faramir | feel so bad!  -Snarf
  307.